Retrieve Order Details

Overview

This interface allows merchants to retrieve detailed results of bank card transfer transactions. It provides comprehensive information about the transfer status, payment details, and transaction metadata.

API URL

Staging Environment: https://uat.test2pay.com/sgs/api/transfer/getTransferToBankCard
Production Environment: https://api.payby.com/sgs/api/transfer/getTransferToBankCard

Request

HTTP Headers

Field Name	Parameter Name	Required	Type	Example	Description
Content Language	Content-Language	Optional	String(10)	en	Language for response content (en for English)
Signature	Sign	Required	String	-	Request signature for authentication
Partner ID	Partner-Id	Required	String(12)	-	Merchant identifier

HTTP Body

Field Name	Parameter Name	Required	Type	Example	Description
Request Time	requestTime	Required	Timestamp(3)	1581493898000	Request timestamp in milliseconds
Business Content	bizContent	Required	GetTransferToBankOrderRequest	-	Business-specific request content

Request Time (`requestTime`)

Required: Yes
Type: Timestamp (milliseconds, 3-digit precision)
Example: 1581493898000
Description: Time the request was initiated.

Business Content (`GetTransferBankCardRequest`)

Field Name	Parameter Name	Required	Type	Example	Description
Merchant Order Number	merchantOrderNo	Required	String(64)	Me23484	Unique order identifier from merchant system

Request Sample

HTTP Headers

{
    "Content-Language": "en",
    "Content-Type": "application/json",
    "Partner-Id": "200000018128",
    "sign": "RXF8WmC67QSnr62l3oU33fjpUvAo6Yrgvk05c/vYLtmHRGMoAH4qSnap2pto3mY7KgyP5wkNUsyQXJ/ZwbfccSONLb5zA7Z7q74IsOwdJw3BKXxVWr4tfjkA02Pfcp0cZWjE/Y8jTcbtgdc5VI90LNmkgPWbrSlDbNW8p3NlhnKg+Xfl95SgMBPF9afttsU/2a5jLnZXSVcXoSthxpJ6XkZwd45+jhOjBguT+IC8uLVSNRvwDisRGgf9PYv39OH6ITEhbY2sgjkdzBZBOZlt7awy2vkMEsePsuafwrNhuz7xzjj55PzNzk8+zCUu/791OhC/eFUyGimtDw5mX9cyQw=="
}

HTTP Body

{
    "body": {
        "bizContent": {
            "merchantOrderNo": "M536433721888"
        },
        "requestTime": 1585142880000
    }
}

Response

HTTP Headers

Field Name	Parameter Name	Required	Type	Example	Description
Content Language	Content-Language	Optional	String(10)	en	Language for response content (en for English)
Signature	Sign	Required	String	-	Response signature for verification
Partner ID	Partner-Id	Required	String(12)	-	Merchant identifier

HTTP Body

Field Name	Parameter Name	Required	Type	Example	Description
Response Header	head	Required	ResponseHeader	-	Response metadata and status information
Response Body	body	Optional	PlaceTransferToBankOrderResponse	-	Transfer order details

Response Header

Attributes

Response Header

Request Status
- Variable Name: applyStatus
- Required: Yes
- Type: String(16)
- Example: SUCCESS
- Description:
  - SUCCESS – Application successful
  - FAIL – Application failed
  - ERROR – Exception occurred
Return Error Code
- Variable Name: code
- Required: Yes
- Type: String(10)
- Example: 0
- Description: Return code
Return Message
- Variable Name: msg
- Required: No
- Type: String(200)
- Example: -
- Description: Return message

Response Body

Transfer Order Response (PlaceTransferToBankOrderResponse)

Field Name	Parameter Name	Required	Type	Example	Description
Transfer Order Information	transferBankCardOrder	Required	TransferBankCardOrder	-	Complete transfer order details

Attributes

TransferBankCardOrder

Request Time (requestTime)
- Required: Yes
- Type: Timestamp(3)
- Example: 1581493898000
- Description: —
Merchant Order Number (merchantOrderNo)
- Required: Yes
- Type: String(64)
- Example: S10000
- Description: —
PayBy Order Number (orderNo)
- Required: Yes
- Type: String(32)
- Example: O1000
- Description: —
Product Name (product)
- Required: Yes
- Type: String(200)
- Example: Transfer Bank Card
- Description: —
Order Status (status)
- Required: Yes
- Type: —
- Example: -
- Description: —
Amount (amount)
- Required: Yes
- Type: Money
- Example: —
- Description: —
Account Holder Type (accountHolderType)
- Required: Yes
- Type: String(16)
- Example: INDIVIDUAL
- Description: INDIVIDUAL or CORPORATE
First Name (firstName)
- Required: Optional
- Type: String(200)
- Example: —
- Description: SHA256 of original text, required if INDIVIDUAL
Last Name (lastName)
- Required: Optional
- Type: String(200)
- Example: —
- Description: SHA256 of original text, required if INDIVIDUAL
Middle Name (middleName)
- Required: Optional
- Type: String(200)
- Example: —
- Description: SHA256 of original text
Company Name (companyName)
- Required: Optional
- Type: String(200)
- Example: —
- Description: SHA256 of original text, required if CORPORATE
Card Number (cardNumber)
- Required: Yes
- Type: String(64)
- Example: —
- Description: SHA256 of original text
Expiry Month (expiryMonth)
- Required: Yes
- Type: String(2)
- Example: —
- Description: —
Expiry Year (expiryYear)
- Required: Yes
- Type: String(4)
- Example: —
- Description: —
Payment Memo (memo)
- Required: Optional
- Type: String(128)
- Example: —
- Description: —
Notification URL (notifyUrl)
- Required: Optional
- Type: String(200)
- Example: —
- Description: —
Failure Description (failDes)
- Required: Optional
- Type: String(200)
- Example: -
- Description: Reason for order failure
Bank Reference Number (bankReference)
- Required: Optional
- Type: String(128)
- Example: —
- Description: —
Payer Fee Amount (payerFeeAmount)
- Required: Yes
- Type: Money
- Example: -
- Description: —
Fee Payer ID (payerFeeMemberId)
- Required: Yes
- Type: String(32)
- Example: -
- Description: ID of the party paying the fee
Payment Time (paidTime)
- Required: Yes
- Type: Date
- Example: -
- Description: Time of deduction
Refund Time (refundedTime)
- Required: Optional
- Type: Date
- Example: —
- Description: Time of refund

Response Sample

HTTP Headers

{
    "sign": "Yv+C2lOQmfERdm5GF9b2V4Y98HmX/6CFyconeOW36AoPqcb7InRcP9E5GnvJLfMoCScuNP4FBdJ5tJpL0A7yPHUMfxARi05jFRSMG97JJazDbWTbRkNM1ZupmTubhUvxvRCgvJp1k0c5yrHph+F+++W5eYho92xnkNgd62BS27i0iDRGzGSmsaPpK7MFcdlvnbbnmDZZJ0LH6RhYiJLYKl+znllQx3jNfCRjV28o22FZ35Q43mZTsS4uAZWbZ/KfaqWoV3sN62Cjj8DSg3mD6GCGWSVbxLq58DUxAq+6GwJ7Gj0Dc9nMXP3gnFW7dodQ9AjL2iHnH6Zh1Pw2D5/ung=="
}

HTTP Body

{
    "body": {
        "transferToBankCard": {
            "amount": {
                "amount": 0.1,
                "currency": "AED"
            },
            "partnerId": "200000429066",
            "notifyUrl": "http://yoursite.com/api/notification",
            "memo": "Bonus",
            "createdTime": 1741917501666,
            "payerFeeAmount": {
                "amount": 0,
                "currency": "AED"
            },
            "payerFeeMemberId": "200000429066",
            "orderNo": "131741917501042130",
            "merchantOrderNo": "7a5b47a4-1824-4a4d-b581-9b0ebd5dd436",
            "product": "Transfer Bank Card",
            "status": "CREATED",
            "paidTime": 1741917502000,
            "accountHolderType": "INDIVIDUAL",
            "cardNumber": "6b59af6dcc4fb841d5f053a852ed917fd5eecad0cc2c3e3507540c065f520a4c",
            "expiryMonth": "08",
            "expiryYear": "2028",
            "firstName": "c6f27629d041725bb227a0d718641d220d69356cd82b3b7230f1d0dff950de5f",
            "lastName": "15d6dacb4fbda825195e5873c175a9b093daa32345c708ac18411365f6fc6038",
            "middleName": "15d6dacb4fbda825195e5873c175a9b093daa32345c708ac18411365f6fc6038"
        }
    },
    "head": {
        "applyStatus": "SUCCESS",
        "code": "0",
        "msg": "SUCCESS",
        "traceCode": "974825"
    }
}

Response Codes

Code	Message	Cause	Workaround
0	SUCCESS	Request processed successfully	-
400	INVALID_PARAMETER	Invalid request parameters	Review and correct request parameters
400	REQUESTTIME_TOO_EARLY	Request time is too early compared to current time	Adjust request timestamp
400	REQUESTTIME_TOO_LATER	Request time is too late compared to current time	Adjust request timestamp
402	RATE_LIMIT_REJECT	Request frequency exceeds allowed limit	Reduce request frequency
403	UNAUTHORIZED	API access not authorized	Contact PayBy for authorization
404	SERVICE_NOT_AVAILABLE	API service is unavailable	Contact PayBy support
500	SYSTEM_ERROR	Internal system error	Contact PayBy support and retry later
504	SERVICE_TIMEOUT	Service request timeout	Retry the request
601	RISK_FAIL	Risk control validation failed	Review and adjust business parameters
62004	MERCHANT_ORDER_NO_NOT_EXIST	Merchant order number does not exist	Verify and correct merchant order number

Retrieve Order Details

Overview​

API URL​

Request​

HTTP Headers​

HTTP Body​

Request Time (requestTime)​

Business Content (GetTransferBankCardRequest)​

Request Sample​

HTTP Headers​

HTTP Body​

Response​

HTTP Headers​

HTTP Body​

Response Header​

Response Body​

Response Sample​

HTTP Headers​

HTTP Body​

Response Codes​

Overview

API URL

Request

HTTP Headers

HTTP Body

Request Time (`requestTime`)

Business Content (`GetTransferBankCardRequest`)

Request Sample

HTTP Headers

HTTP Body

Response

HTTP Headers

HTTP Body

Response Header

Response Body

Response Sample

HTTP Headers

HTTP Body

Response Codes